Fix docs for union member casing #1719
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dtobin
reviewed
Jan 14, 2025
docs/spec/conjure_definitions.md
Outdated
| @@ -233,8 +233,8 @@ It is common for a generator to also generate a visitor interface for each union | |||
| Payload: | |||
| package: com.palantir.example | |||
| union: | |||
| serviceLog: ServiceLog | |||
| notAServiceLog: RequestLog | |||
| ServiceLog: ServiceLog | |||
There was a problem hiding this comment.
The change should be the inverse - the docs above are incorrect, and union names must be lowerCamelCase.
There was a problem hiding this comment.
Ack - flipped the inconsistency Correction.
dtobin
reviewed
Jan 14, 2025
docs/spec/conjure_definitions.md
Outdated
| @@ -222,7 +222,7 @@ Definition for a union complex data type. | |||
|
|
|||
| Field | Type | Description | |||
| ---------- | ---- | ----------- | |||
| union | Map[`string` → [FieldDefinition][] or [ConjureType][]] | **REQUIRED**. A map from union names to type names. If the value of the field is a `string` it MUST be a type name that exists within the Conjure definition. Union names MUST be in PascalCase. | |||
| union | Map[`string` → [FieldDefinition][] or [ConjureType][]] | **REQUIRED**. A map from union names to type names. If the value of the field is a `string` it MUST be a type name that exists within the Conjure definition. Union names MUST be in [camelCase](https://developer.mozilla.org/en-US/docs/Glossary/Camel_case). | |||
There was a problem hiding this comment.
Union names need to be specifically lowerCamelCase. UpperCamelCase is not supported.
dtobin
changed the title
dtobin
reviewed
Jan 14, 2025
docs/spec/conjure_definitions.md
Outdated
| @@ -222,7 +222,7 @@ Definition for a union complex data type. | |||
|
|
|||
| Field | Type | Description | |||
| ---------- | ---- | ----------- | |||
| union | Map[`string` → [FieldDefinition][] or [ConjureType][]] | **REQUIRED**. A map from union names to type names. If the value of the field is a `string` it MUST be a type name that exists within the Conjure definition. Union names MUST be in PascalCase. | |||
| union | Map[`string` → [FieldDefinition][] or [ConjureType][]] | **REQUIRED**. A map from union names to type names. If the value of the field is a `string` it MUST be a type name that exists within the Conjure definition. Union names MUST be in [lowerCamelCase](https://www.techtarget.com/whatis/definition/lowerCamelCase). | |||
There was a problem hiding this comment.
This website doesn't look authoritative; we should omit the link here. lowerCamelCase is used elsewhere in this repo without reference - I think it's common enough not to cause confusion!
dtobin
approved these changes
Jan 14, 2025
carterkozak
approved these changes
Jan 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this PR
The definitions mentions that "Union names MUST be in PascalCase", however the example given below had the union names in camelCase.
After this PR
==COMMIT_MSG==
==COMMIT_MSG==
The example now has union names in PascalCase, conforming to the aforementioned convention.The docs now mention that the union Names must be in camelCase.Possible downsides?